/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.plugin;

import kameleon.exception.KameleonException;
import kameleon.util.FileConstants;

/**
 * Superclass for all plug-ins.
 * 
 * <p>All plug-in must extend this class (directly or not) and 
 * implement its methods to be usable by the software.
 * 
 * @author		Schnell Michaël
 * @version		1.0
 */
public abstract class PlugIn {

	/**
	 * Sole constructor.
	 */
	protected PlugIn() {
		super() ;
	}// PlugIn()
	
	/**
	 * Copies images representing the format treated by this plug-in into the given folder.
	 * 
	 * <p>The software required three pictures from every plug-in.
	 * <ol>
	 * <li>{@code <format id>_icon.png} (size - 50x50px): normal picture for this format
	 * <li>{@code <format id>_gray_icon.png} (size - 50x50px): grayed out picture for this format
	 * <li>{@code <format id>_mini.png} (size - 32x32px): small normal picture for this format
	 * </ol> The images should be in png format.
	 * 
	 * @param	targetFolder
	 * 			target folder for the format pictures
	 * 
	 * @throws 	KameleonException
	 * 			if an exception occurred while writing the pictures
	 * 
	 * @see		FileConstants#FORMAT_ICON_FILE_NAME
	 * @see		FileConstants#FORMAT_GRAY_ICON_FILE_NAME
	 * @see		FileConstants#FORMAT_MINI_FILE_NAME
	 */
	public abstract void copyPicture(String targetFolder) throws KameleonException ;
	
}// class PlugIn